feat(middleware): optional RateLimiterStoreContext for response headers (#2961)#3007
Conversation
…rs (#2961) Adds an optional RateLimiterStoreContext interface. When the configured store implements AllowContext(c, identifier), the rate limiter calls it instead of Allow, giving the store access to the request context so it can set response headers such as Retry-After / X-RateLimit-*. Fully backward compatible: stores implementing only Allow are unchanged. This is the optional-interface approach proposed by the maintainer in the issue thread; it does not alter the existing Allow interface or the built-in store. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Note: this is same (subset) change as #2985 does but @leno23 created that PR against |
…#2961) Implements AllowContext on RateLimiterMemoryStore so the default store sets X-RateLimit-Limit, X-RateLimit-Remaining, and (on deny) Retry-After headers out of the box — mirroring the v4 PR #2985 by @leno23 on the v5 line. Allow() is refactored to share an internal allow() with AllowContext; the optional RateLimiterStoreContext interface (added earlier in this PR) routes the middleware to AllowContext when the store implements it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Thanks @aldas — you're right, this is the v5 counterpart of #2985. I've expanded it to mirror that PR: One small divergence: the optional interface is exported here ( |
2 participants
Problem (#2961)
The rate limiter sets no
Retry-After/X-RateLimit-*headers, and theRateLimiterStoreinterface (Allow(identifier) (bool, error)) gives a store no way to set them either.Fix
Add an optional interface:
When the configured store implements it, the middleware calls
AllowContext(with the request context) instead ofAllow, so the store can set response headers on the allow/deny decision.Fully backward compatible — stores implementing only
Alloware unaffected; the existing interface and the built-in memory store are unchanged.This is the optional-interface approach @aldas proposed in the issue thread (mirroring the pattern used in the v4 proxy middleware). It intentionally does not retrofit the built-in store with full metadata plumbing (the part flagged as a larger rewrite in the thread) — it just provides the hook so stores can set headers.
Test
TestRateLimiter_storeAllowContextIsPreferred(written first; fails before the change): a store implementingAllowContextis preferred overAllowand can set aRetry-Afterheader. gofmt/vet clean; full rate-limiter suite passes (backward compat confirmed).Addresses #2961.
🤖 Generated with Claude Code